sys-service API

sys-service supports 18 commands:

Services: pos eve edp status route sensor msg cfg asset mod map sys tftp eng tag rec aprec test index

/epe/sys/configget		Input:	Output:
	Description: Lists current configuration, sorted by key name. Role Required: viewer Call Counter: Total: 3, Failed: 0		CONFIG.* - [String] configuration parameters
/epe/sys/diagnose		Input:	Output:
	Description: Reports the status of the RTLS Controller. Performs a number of system tests and reports their results. First in the reply is result with an errorcount. If errorcount is zero, all is ok. After the result are descriptions of system tests. Role Required: viewer Call Counter: Total: 3, Failed: 0		RESULT.testcount - [int] number of test that were performed RESULT.errorcount - [int] number of errors TEST.name - [String] test name TEST.description - [String] test description TEST.error - [String] error reason for failed test TEST.link - [String] optional link with more information TEST.linkinfo - [String] optional link description
/epe/sys/errorcodelist		Input:	Output:
	Description: Lists all error codes. Example 1: List all error codes. /epe/sys/errorcodelist Role Required: viewer Call Counter: Total: 0, Failed: 0		ERRORCODE.code - [int] error code ERRORCODE.description - [String] error description
/epe/sys/licenseget POST version		Input:	Output:
	Description: Gets information from the current license. Example 1: Get all license attributes. /epe/sys/licenseget Example 2: Get license expiration date. /epe/sys/licenseget?key=Expires Role Required: viewer Call Counter: Total: 426, Failed: 0	key (optional) - [String] name of the license attribute	LICENSE.LicenseFileCount - [int] number of licenses LICENSE.* - [String] license attributes
/epe/sys/loggetlevel POST version		Input:	Output:
	Description: Returns current log categories and their levels. If category is not specified, returns only categories that set their own levels instead of inheriting. Example 1: List all epe-categories. /epe/sys/loggetlevel?category=epe Example 2: List all categories, including those that inherit their level from parent. Large list. /epe/sys/loggetlevel?category=* Role Required: viewer Call Counter: Total: 3, Failed: 0	category (optional) - [String] category prefix; set to '*' to list all categories	LOGGER.name - [String] logger name LOGGER.level - [String] logger level, such as WARN LOGGER.level-effective - [String] effective logger level
/epe/sys/logread POST version		Input:	Output:
	Description: Reads log file content. Most recent log line is at the bottom of the list. If size is not specified, returns 100K worth of logs. Example 1: Read only last 2000 bytes of logs. /epe/sys/logread?size=2000 Example 2: Read only last 10000 bytes of logs. /epe/sys/logread?size=10000 Role Required: viewer Call Counter: Total: 0, Failed: 0	size (optional) - [int] amount of logs to be read, in bytes; default is 100000	LOGITEM.date - [String] timestamp of the log message LOGITEM.msg - [String] log message
/epe/sys/logsetlevel POST version		Input:	Output:
	Description: Sets log level. Returns the logger that was set. Example 1: Set level of epe-category (and all categories underneath) to INFO. /epe/sys/logsetlevel?category=epe&level=INFO Example 2: Set epe.api to INFO. (Means that all HTTP requests are logged.) /epe/sys/logsetlevel?category=epe.api&level=INFO Example 3: Set epe.api to DEBUG. (Means that all HTTP requests and replies are logged.) /epe/sys/logsetlevel?category=epe.api&level=DEBUG Example 4: Clear level of epe.api. /epe/sys/logsetlevel?category=epe.api&level= Example 5: Set root category level to ERROR. /epe/sys/logsetlevel?category=root&level=ERROR Role Required: poweruser Call Counter: Total: 0, Failed: 0	category (required) - [String] name of category level (required) - [String] level, one of: OFF, FATAL, ERROR, WARN, INFO, DEBUG or empty; empty string clears level	LOGGER.name - [String] logger name LOGGER.level - [String] logger level, such as WARN LOGGER.level-effective - [String] effective logger level
/epe/sys/rolelist POST version		Input:	Output:
	Description: Lists all user roles. Ordered by name. Example 1: List all roles. /epe/sys/rolelist Example 2: View role with id 1 /epe/sys/rolelist?roleid=1 Role Required: viewer Call Counter: Total: 0, Failed: 0	roleid (optional) - [long] role id	ROLE.roleid - [long] role id ROLE.name - [String] role name ROLE.description - [String] role description ROLE.createdon - [String] create time of the role ROLE.modifiedon - [String] modify time of the role
/epe/sys/snmpctrl POST version		Input:	Output:
	Description: Starts and stops SNMP agent. Example 1: Start SNMP server /epe/sys/snmpctrl?action=start Example 2: Stop SNMP server /epe/sys/snmpctrl?action=stop Role Required: poweruser Call Counter: Total: 0, Failed: 0	action (required) - [String] start or stop
/epe/sys/threadlist POST version		Input:	Output:
	Description: Lists all running threads or threads that are halted. List is sorted based on cputime; most cpu time taken thread first. This call exists for troubleshooting and performance diagnosing. Example 1: List only halted threads /epe/sys/threadlist?halted=1 Role Required: viewer Call Counter: Total: 0, Failed: 0	halted (optional) - [int] boolean: 0 or 1	THREAD.id - [long] thread id THREAD.name - [String] thread name THREAD.state - [String] thread state, such as RUNNABLE THREAD.cputime - [long] total CPU time of thread in milliseconds
/epe/sys/userbrowse		Input:	Output:
	Description: Browse users. Example 1: Show currently logged in user. /epe/sys/userbrowse Role Required: viewer Call Counter: Total: 1, Failed: 0		USER.useruid - [String] user UID USER.name - [String] user name USER.rolename - [String] role name
/epe/sys/usercreate POST version		Input:	Output:
	Description: Creates a new user. Example 1: Create user myuser with password xx, and havig user role. /epe/sys/usercreate?name=myuser&password=xx&role=user Role Required: administrator Call Counter: Total: 0, Failed: 0	name (required) - [String] username password (required) - [String] password role (required) - [String] Name the user role. Possible values are administrator, poweruser, tagoperator and viewer. description (optional) - [String] description organization (optional) - [String] organization	USER.userid - [long] user id USER.useruid - [String] user UID USER.name - [String] user name USER.description - [String] user description USER.createdon - [String] create time of the user USER.modifiedon - [String] modify time of the user USER.roleid - [long] role id USER.rolename - [String] role name
/epe/sys/userdelete POST version		Input:	Output:
	Description: Deletes a user. User cannot delete her/himself. Example 1: Delete user with id 1. /epe/sys/userdelete?userid=1 Role Required: administrator Call Counter: Total: 0, Failed: 0	userid (optional) - [long] user id useruid (optional) - [String] user UID
/epe/sys/useredit POST version		Input:	Output:
	Description: Changes user properties. Example 1: Create user myuser with password xx, and belonging to user role with id 1. /epe/sys/useredit?userid=1&name=myuser&password=xx&role=poweruser Role Required: administrator Call Counter: Total: 0, Failed: 0	userid (optional) - [long] user id useruid (optional) - [String] user UID name (optional) - [String] username password (optional) - [String] password description (optional) - [String] description role (optional) - [String] name of the user role. Possible values are administrator, poweruser, tagoperator and viewer. organization (optional) - [String] organization	USER.userid - [long] user id USER.useruid - [String] user UID USER.name - [String] user name USER.description - [String] user description USER.createdon - [String] create time of the user USER.modifiedon - [String] modify time of the user USER.roleid - [long] role id USER.rolename - [String] role name
/epe/sys/userlist POST version		Input:	Output:
	Description: Lists all users. Example 1: List all users. /epe/sys/userlist Example 2: View user with id 1 /epe/sys/userlist?userid=1 Example 3: View user with uid g3720A3C8C43BFC41A0A46D506E647A32 /epe/sys/userlist?useruid=g3720A3C8C43BFC41A0A46D506E647A32 Example 4: List first 10 users whose name match search criteria /epe/sys/userlist?search=Joe&maxnum=10 Role Required: viewer Call Counter: Total: 0, Failed: 0	userid (optional) - [long] user id useruid (optional) - [String] user UID maxnum (optional) - [int] maximum number of users to list, default 100 search (optional) - [String] list users matching search string	USER.userid - [long] user id USER.useruid - [String] user UID USER.name - [String] user name USER.description - [String] user description USER.createdon - [String] create time of the user USER.modifiedon - [String] modify time of the user USER.roleid - [long] role id USER.rolename - [String] role name
/epe/sys/_clear		Input:	Output:
	Description: SPECIAL. Resets all service specific counters. Role Required: poweruser Call Counter: Total: 0, Failed: 0
/epe/sys/_list POST version		Input:	Output:
	Description: SPECIAL. Lists the available commands, their arguments, responses, required roles, call counters and optional help descriptions. Role Required: Call Counter: Total: 1, Failed: 0	help (optional) - [int] set to 1 to get also HTML help description of the commands. Default is 0.	COMMAND.name - [String] command name COMMAND.arg - [String] mandatory argument COMMAND.optarg - [String] optional argument COMMAND.response - [String] response field COMMAND.internal - [int] 1 for internal command COMMAND.role - [String] required role COMMAND.callcount - [int] number of calls COMMAND.callcountinternal - [int] number of internal calls COMMAND.callcountfailure - [int] number of failed calls COMMAND.htmlhelp - [String] command description in HTML format
/epe/sys/_status		Input:	Output:
	Description: SPECIAL. Returns status information about the service. Role Required: viewer Call Counter: Total: 246, Failed: 0		STATUS.callcount - [int] total number of calls for the service STATUS.callcountinternal - [int] total number of internal calls for the service STATUS.callcountfailure - [int] total number of failed calls for the service STATUS.commandcount - [int] number of commands in service STATUS.* - [String] service specific status information

(The data in this page was generated from /epe/sys/_list?help=1)